Contents x
    Get all readers for a project.
    • 12 May 2026
    • 8 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Get all readers for a project.

    • Updated on 12 May 2026
    • 8 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article summary

    Get
    /v3/projects/{project_id}/readers

    Returns a paginated list of readers for the specified project. Use the searchEmail query parameter to filter readers by email address. Note that this endpoint fetches all readers from the data store and then applies in-memory pagination, so response times may increase for projects with a large number of readers. Related endpoints: POST /v3/projects/{projectId}/readers to create a reader, GET /v3/projects/{projectId}/readers/groups to list reader groups.

    Security
    OAuth

    All V3 endpoints require a Bearer token. Generate tokens in the Document360 portal under Settings > API Tokens. Tokens are project-scoped, require the customerApi scope, and do not expire by default. Tokens can be revoked at any time from the portal. Include the token in every request: Authorization: Bearer <your-token>. Alternatively, use the Authorize button below to sign in via OAuth2 Authorization Code flow with PKCE.

    FlowAuthorization Code
    Authorization URLhttps://identity.document360.net/connect/authorize
    Token URLhttps://identity.document360.net/connect/token
    Scopes:
    customerApiDocument360 Customer API
    Path parameters
    project_id
    string (uuid) Required

    The unique identifier of the project. Retrieve project IDs from GET /v3/projects.

    Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
    Query parameters
    page
    integer (int32)

    Page number (1-based). Defaults to 1.

    Minimum1
    Default1
    page_size
    integer (int32)

    Number of results per page. Defaults to 25. Maximum 100.

    Minimum1
    Maximum100
    Default25
    search_email
    string

    Filter readers by email address.

    cursor
    string

    Opaque cursor from a previous response's next_cursor. When provided, page is ignored.

    include_total_count
    boolean

    Set to true to include total_count in the response. Default: false.

    Defaultfalse
    Responses
    200

    Readers retrieved successfully.

    List of readers

    Returns a paginated list of readers in the project

    {
  "data": [
    {
      "id": "d4e5f6a7-b8c9-4d0e-a1b2-c3d4e5f6a7b8",
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "[email protected]",
      "access_scope": {
        "access_level": "category",
        "categories": [
          {
            "project_version_id": "f7a8b9c0-d1e2-4f3a-b4c5-d6e7f8a9b0c1",
            "category_id": "c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5",
            "lang_code": "en"
          }
        ],
        "project_versions": [],
        "languages": []
      },
      "associated_reader_groups": [
        "b2c3d4e5-f6a7-4b8c-9d0e-a1b2c3d4e5f6"
      ],
      "is_invite_sso_user": false,
      "last_login_at": "2025-03-15T10:30:00Z"
    },
    {
      "id": "e5f6a7b8-c9d0-4e1f-a2b3-c4d5e6f7a8b9",
      "first_name": "Bob",
      "last_name": "Martinez",
      "email": "[email protected]",
      "access_scope": {
        "access_level": "version",
        "categories": [],
        "project_versions": [
          "f7a8b9c0-d1e2-4f3a-b4c5-d6e7f8a9b0c1"
        ],
        "languages": []
      },
      "associated_reader_groups": [],
      "is_invite_sso_user": true,
      "last_login_at": null
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 25,
    "total_count": 2,
    "has_more": false,
    "next_cursor": null
  },
  "success": true,
  "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "errors": null,
  "warnings": null
}
    Expand All
    object

    Paginated API response containing a list of items.

    data
    Array of object (ReaderResponse)

    List of items for the current page.

    object

    Represents a reader (external user) who has access to the knowledge base.

    id
    string (uuid) | null

    Unique identifier of the reader.

    Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
    first_name
    string | null

    First name of the reader.

    last_name
    string | null

    Last name of the reader.

    email
    string (email) | null

    Email address of the reader.

    Example[email protected]
    access_scope
    object | null

    The access scope defining which content this reader can view.

    access_level
    string

    The level at which access is scoped. Possible values: 0 = None, 1 = Category, 2 = Version, 3 = Project, 4 = Language, 5 = Article, 6 = Workspace.

    Valid values[ "none", "category", "version", "project", "language", "article", "workspace" ]
    categories
    Array of object (CategoryScope) | null

    List of specific category scopes when AccessLevel is Category (1). Null or empty for broader access levels.

    object

    Specifies access to a specific category within a project version and language.

    project_version_id
    string | null

    Unique identifier of the project version containing the category. Retrieve from GET /v3/projects/{projectId}/project-versions.

    category_id
    string | null

    Unique identifier of the category to grant access to. Retrieve from GET /v3/projects/{projectId}/categories.

    lang_code
    string | null

    Language code for the category translation (e.g., "en", "fr", "de"). Retrieve available languages from GET /v3/projects/{projectId}/languages.

    Exampleen
    project_versions
    Array of string | null

    List of project version IDs the reader has access to when AccessLevel is Version (2). Retrieve version IDs from GET /v3/projects/{projectId}/project-versions.

    string
    languages
    Array of object (LanguageScope) | null

    List of language scopes defining which translations the reader can access. Applicable when AccessLevel is Language (4).

    object

    Specifies access to a specific language within a project version.

    project_version_id
    string | null

    Unique identifier of the project version. Retrieve from GET /v3/projects/{projectId}/project-versions.

    lang_code
    string | null

    Language code to grant access to (e.g., "en", "fr", "de"). Retrieve available languages from GET /v3/projects/{projectId}/languages.

    Exampleen
    associated_reader_groups
    Array of string | null

    List of reader group IDs that this reader belongs to. Retrieve group IDs from GET /v3/projects/{projectId}/readers/groups.

    string
    is_invite_sso_user
    boolean

    Whether this reader was invited via SSO authentication.

    last_login_at
    string (date-time) | null

    Date and time when the reader last logged in. Null if the reader has never logged in.

    pagination
    object

    Pagination metadata.

    page
    integer (int32)

    Current page number (1-based). Returns 0 when using cursor-based pagination.

    page_size
    integer (int32)

    Number of items per page.

    total_count
    integer (int64) | null

    Total number of items across all pages. Only populated when include_total_count=true is specified in the request.

    has_more
    boolean

    Whether additional pages are available.

    next_cursor
    string | null

    Opaque cursor to retrieve the next page of results. Pass this value as the cursor query parameter. Null when there are no more pages.

    success
    boolean

    Whether the API request was successful.

    request_id
    string

    Unique identifier for request tracing and correlation.

    Min length1
    errors
    Array of object (ApiError) | null

    List of errors if the request failed.

    object

    Represents an error returned by the API.

    code
    string

    Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

    Min length1
    message
    string

    Human-readable error message.

    Min length1
    field
    string | null

    The request field that caused the error, if applicable.

    details
    string | null

    Additional context about the error.

    warnings
    Array of object (ApiWarning) | null

    List of non-fatal warnings from the request.

    object

    Represents a non-fatal warning from the API.

    code
    string

    Machine-readable warning code.

    Min length1
    message
    string

    Human-readable warning message.

    Min length1
    401

    Authentication token is missing or invalid.

    Headers
    WWW-Authenticate
    string
    Indicates the authentication scheme required. Returns `Bearer` with optional `error` and `error_description` parameters per RFC 6750.
    Missing or invalid token

    Authentication token is missing or invalid.

    {
  "type": "https://developer.document360.com/errors/unauthorized",
  "title": "Unauthorized.",
  "status": 401,
  "detail": "The authentication token is missing or has expired.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Bearer token is missing or invalid.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}
    Expand All
    object

    RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

    type
    string

    URI reference identifying the error type (links to documentation).

    Min length1
    title
    string

    Short human-readable summary of the error type.

    Min length1
    status
    integer (int32)

    HTTP status code.

    detail
    string | null

    Human-readable explanation specific to this occurrence.

    instance
    string | null

    URI of the request that generated the error.

    trace_id
    string | null

    Request trace identifier for correlation.

    errors
    Array of object (ApiError) | null

    Structured list of specific errors (extension field).

    object

    Represents an error returned by the API.

    code
    string

    Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

    Min length1
    message
    string

    Human-readable error message.

    Min length1
    field
    string | null

    The request field that caused the error, if applicable.

    details
    string | null

    Additional context about the error.

    warnings
    Array of object (ApiWarning) | null

    Non-fatal warnings (extension field).

    object

    Represents a non-fatal warning from the API.

    code
    string

    Machine-readable warning code.

    Min length1
    message
    string

    Human-readable warning message.

    Min length1
    429

    Rate limit exceeded. Retry after the duration specified in the Retry-After header.

    Headers
    Retry-After
    integer
    Number of seconds to wait before retrying the request. Use exponential backoff with jitter for optimal retry behavior.
    X-RateLimit-Limit
    integer
    The maximum number of requests allowed in the current time window. Limits are applied per API token per project.
    X-RateLimit-Remaining
    integer
    The number of requests remaining in the current time window. When this reaches 0, subsequent requests will receive a 429 response.
    X-RateLimit-Reset
    integer
    The UTC epoch timestamp (in seconds) when the current rate limit window resets.
    Rate limit exceeded

    Rate limit exceeded.

    {
  "type": "https://developer.document360.com/errors/too-many-requests",
  "title": "Too Many Requests.",
  "status": 429,
  "detail": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "message": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}
    Expand All
    object

    RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

    type
    string

    URI reference identifying the error type (links to documentation).

    Min length1
    title
    string

    Short human-readable summary of the error type.

    Min length1
    status
    integer (int32)

    HTTP status code.

    detail
    string | null

    Human-readable explanation specific to this occurrence.

    instance
    string | null

    URI of the request that generated the error.

    trace_id
    string | null

    Request trace identifier for correlation.

    errors
    Array of object (ApiError) | null

    Structured list of specific errors (extension field).

    object

    Represents an error returned by the API.

    code
    string

    Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

    Min length1
    message
    string

    Human-readable error message.

    Min length1
    field
    string | null

    The request field that caused the error, if applicable.

    details
    string | null

    Additional context about the error.

    warnings
    Array of object (ApiWarning) | null

    Non-fatal warnings (extension field).

    object

    Represents a non-fatal warning from the API.

    code
    string

    Machine-readable warning code.

    Min length1
    message
    string

    Human-readable warning message.

    Min length1
    500

    An unexpected server error occurred.

    Unexpected server error

    Unexpected server error.

    {
  "type": "https://developer.document360.com/errors/internal-error",
  "title": "Internal Server Error.",
  "status": 500,
  "detail": "An unexpected error occurred. Please try again or contact support.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "message": "An unexpected error occurred.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}
    Expand All
    object

    RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

    type
    string

    URI reference identifying the error type (links to documentation).

    Min length1
    title
    string

    Short human-readable summary of the error type.

    Min length1
    status
    integer (int32)

    HTTP status code.

    detail
    string | null

    Human-readable explanation specific to this occurrence.

    instance
    string | null

    URI of the request that generated the error.

    trace_id
    string | null

    Request trace identifier for correlation.

    errors
    Array of object (ApiError) | null

    Structured list of specific errors (extension field).

    object

    Represents an error returned by the API.

    code
    string

    Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

    Min length1
    message
    string

    Human-readable error message.

    Min length1
    field
    string | null

    The request field that caused the error, if applicable.

    details
    string | null

    Additional context about the error.

    warnings
    Array of object (ApiWarning) | null

    Non-fatal warnings (extension field).

    object

    Represents a non-fatal warning from the API.

    code
    string

    Machine-readable warning code.

    Min length1
    message
    string

    Human-readable warning message.

    Min length1
    Was this article helpful?
    What's Next
    Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy.
    Products
    Company
    Top Features
    Solutions
    Existing Users
    Connect With Us
    Sales and Support
    Copyright © Abc Inc. All Rights Reserved